Skip to content
This repository was archived by the owner on Apr 12, 2024. It is now read-only.

Conversation

stevemao
Copy link
Contributor

@stevemao stevemao commented May 13, 2016

What kind of change does this PR introduce?

docs update

What is the current behavior? (You can also link to an open issue here)

Google CDN e.g. {% code %}"//ajax.googleapis.com/ajax/libs/angularjs/X.Y.Z/"{% endcode %}

What is the new behavior (if this is a feature change)?

Google CDN e.g.
"//ajax.googleapis.com/ajax/libs/angularjs/X.Y.Z/angular-mock.js"

Does this PR introduce a breaking change?

No

Please check if the PR fulfills these requirements

Other information:

The inline installation can't display the proper context. On the website, it shows something like

Google CDN e.g. {% code %}"//ajax.googleapis.com/ajax/libs/angularjs/X.Y.Z/"{% endcode %}

The inline installation can't display the proper context. On the website, it shows something like

```
Google CDN e.g. {% code %}"//ajax.googleapis.com/ajax/libs/angularjs/X.Y.Z/"{% endcode %}
```
@Narretz
Copy link
Contributor

Narretz commented May 13, 2016

Hm, that's bad. But we cannot use the default installation notes because they will make it look like you should include ngMocks into your application code wheras it should be included in your test runner script.

@stevemao
Copy link
Contributor Author

Oh well. The markup is wrong. I'm not familiar with the syntax. How do I fix it? 😄

@Narretz
Copy link
Contributor

Narretz commented May 13, 2016 via email

@gkalpak
Copy link
Member

gkalpak commented May 16, 2016

Basically, we want to let nunjucks parse the docs.installation here.
\cc @petebacondarwin 😁

petebacondarwin added a commit that referenced this pull request May 16, 2016
The `@installation` section should be formatted with markdown, not
nunjucks template directives.

Closes #14604
@gkalpak
Copy link
Member

gkalpak commented May 17, 2016

@petebacondarwin, this is still not 100% fixed. Things like {$ doc.packageName $}, {$ doc.packageFile $} are still literally appearing in the output.

@gkalpak gkalpak reopened this May 17, 2016
@gkalpak gkalpak added this to the Backlog milestone May 17, 2016
@petebacondarwin
Copy link
Contributor

I think that 921f80e fixes these outstanding issues.

@gkalpak gkalpak closed this May 18, 2016
@stevemao
Copy link
Contributor Author

So we don't need context to feed the templates but just hardcode the actual file name and versions?

@gkalpak
Copy link
Member

gkalpak commented May 18, 2016

Generally, he installation instructions are automatically generated based on a template (and fed with dynamical values, e.g. package name, file name etc). There are a couple of cases (including ngMock) where we need specific, non-generic installation instruction, so we provide them directly. In such cases, we can (and should) pass the exact content, including package name and file name.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants